home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / s_line16.zip / S_LINE.DOC < prev    next >
Text File  |  1993-02-23  |  16KB  |  344 lines
  1.          ┌▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄┐
  2.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  3.  ────────┤▌ G  A  M  E  K  E  E  P  E  R    D  O  O  R  W  A  R  E ▐├────────
  4.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  5.          ├▌▒▒▒▒▒▒▒▒▒  Quality BBS Door Software for Less!  ▒▒▒▒▒▒▒▒▐┤
  6.          ├▌▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐┤
  7.          └▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀┘
  8.  
  9.               T H E   S P O R T S   L I N E   P O O L   D O O R
  10.               ~~~~~   ~~~~~~~~~~~   ~~~~~~~   ~~~~~~~   ~~~~~~~
  11.                                  Version 1.6
  12.  
  13.                      Copyright (c) Steve Sharpe 1992,1993
  14.  
  15. SYSTEM REQUIREMENTS
  16. ~~~~~~~~~~~~~~~~~~~
  17. Any BBS capable of producing the following DOOR.SYS drop files:
  18.  
  19.    *  Original "GAP standard" DOOR.SYS (31 line version)
  20.         - for example, Spitfire BBSs use this one!
  21.  
  22.    *  New (currently 52 line) version DOOR.SYS promoted by Raymond Clements
  23.         - for example, PCBoard BBSs use this one!
  24.  
  25. The Sports Line Pool Door can be played using ANSI color or monochrome
  26. graphics.
  27.  
  28. SYSTEM OPTIONS
  29. ~~~~~~~~~~~~~~
  30. The Sports Line Pool Door supports the use of FOSSIL drivers and non-standard
  31. port addresses.  Refer to the INSTALLATION instructions for more information.
  32.  
  33. FILES CONTAINED IN S_LINE16.ZIP
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35.      S_LINE16.EXE  <-- The main program
  36.      S_LINE.DOC    <-- The file you are reading!
  37.      GAME.CFG      <-- The game configuration file
  38.      POOL.CFG      <-- The pool configuration file
  39.      FREEZE.EXE    <-- The program to freeze (lock) the door for update
  40.      1.DAT         <-- Sample team data file (replace with your own)
  41.      2.DAT         <--  "                 "    "                 "
  42.      3.DAT         <--  "                 "    "                 "
  43.      REVISION.DOC  <-- Revision notes
  44.      DOORWARE.DOC  <-- Gamekeeper Doorware
  45.  
  46. FILES CREATED BY S_LINE16.EXE
  47. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  48.      *.USR         <-- Sequential user data files beginning with 0.
  49.      WIN.FIL       <-- File containing win/loss/tie results for each period.
  50.      TOP_PICK.FIL  <-- File containing the top picks for each period.
  51.  
  52. OVERVIEW
  53. ~~~~~~~~
  54.      The Sports Line Pool Door is a multi-player BBS door designed to promote
  55. friendly competition between players as they strive to accurately determine
  56. which competing sports teams will win, lose, or tie their games.  The door
  57. comes complete with built-in title graphics for 4 pools (Football, Baseball,
  58. Basketball, and Generic).  It tracks games by periods, starting with 1.  A
  59. period represents games played on a given date.  The SysOp can load up to 15
  60. competing teams for each period.  Players select which teams they think will
  61. win, lose, or tie their opponents.  At some point before the games are played,
  62. the door is locked from further access.  After the game results for the period
  63. are known, the SysOp (or a designated player) must update the pool.  After
  64. each update, the period advances so that new picks can be made.  The door
  65. calculates the players with the highest percentage of correct picks for each
  66. period and stores the data in a Top Picks file that can be viewed from the
  67. Main Menu.  Players can also review all previously completed periods.  The
  68. registered version of the door also creates a Pickmaster display that
  69. shows the players with the highest percentage of correct picks for all
  70. periods.  The Pickmaster display is shown as the player exits the door.
  71.  
  72. INSTALLATION
  73. ~~~~~~~~~~~~
  74. The Sports Line Pool Door is easy to install.  Simply follow these steps:
  75.  
  76. 1.  'Unzip' the file S_LINE16.ZIP into the directory of your choice.  All files
  77. must remain in the same directory.
  78.  
  79. 2.  Edit the POOL.CFG and GAME.CFG configuration files according to the
  80. CONFIGURATION FILES section of these instructions using your favorite word
  81. processor.  Ensure you save them as ASCII text files.
  82.  
  83. 3.  Create sports team data files using the example from the TEAM DATA FILES
  84. section of these instructions.  Each data file is saved in ASCII text format
  85. with a 'DAT' file extension.  For example, the filename for period 1 teams
  86. will be 1.DAT and the filename for period 2 teams will be 2.DAT, etc.
  87.  
  88. 4.  Create or edit the batch file your BBS will use to activate the door.
  89. The main door program name is S_LINE16.EXE.  For example, if you are running
  90. a Spitfire BBS, you would edit SF.BAT to look similar to the following:
  91.  
  92. :DOOR_A
  93.    REM Place Door A Commands Here
  94.    CD\SF\DOORS\POOL     <-- Change to The Sports Line directory
  95.    S_LINE16 GAME.CFG    <-- The main program with configuration file argument
  96.    CD\SF                <-- Change back to the Spitfire directory
  97.    GOTO LOOP
  98.  
  99. NON-STANDARD PORT USE:  You may specify the use of non-standard communications
  100. ports with the PORT command.  The syntax for the PORT command is PORT:03E8:5,
  101. where 03E8 represents a different base address and 5 indicates the IRQ.  For
  102. example, the main program line in the example above would be changed to
  103. S_LINE16 GAME.CFG PORT:03E8:5 to reflect the use of a non-standard comm port.
  104.  
  105. FOSSIL DRIVER USE:  You may specify the use of a FOSSIL driver with the PORT
  106. command added to the main program command line.  The syntax for the PORT
  107. command is PORT:F:P, where F instructs the door to use a FOSSIL driver and P
  108. identifies the port.  For example, the main program line in the example above
  109. would be changed to S_LINE16 GAME.CFG PORT:F:1 if the SysOp wished to specify
  110. a FOSSIL driver on port 1.
  111.  
  112. NOTE:  The PORT command must be the third command in the main program command
  113. line, if used.  If not used, the door defaults to the use of the 4 standard
  114. communications ports (1-4) by reading the BBS file.
  115.  
  116. 5.  Determine when you want the pool to be locked, awaiting update.  For
  117. example, if you are running a football pool that covers Sunday games, you
  118. would most likely leave the door unlocked until Saturday night.  At a given
  119. time, the FREEZE.EXE program would be executed to automatically lock the pool.
  120. Sometime on Monday, the user who is responsible for updating the pool would
  121. call and enter win/loss/tie data.  The pool would automatically unlock until
  122. the following Saturday night.  The FREEZE.EXE program is normally run as a BBS
  123. event.  The following event batch file example is for SF.BAT (Spitfire):
  124.  
  125. :EVENT_B
  126.    REM Football Pool Freeze
  127.    CD\SF\DOORS\POOL       <-- Change to the pool directory
  128.    FREEZE                 <-- Run FREEZE.EXE to freeze (lock) the pool
  129.    CD\SF                  <-- Change back to the BBS directory
  130.    GOTO LOOP
  131.  
  132. CONFIGURATION FILES
  133. ~~~~~~~~~~~~~~~~~~~
  134. The entries in the POOL.CFG and GAME.CFG files must be accurate or the door
  135. cannot be expected to function properly.  Save your changes to the .CFG files
  136. in ASCII text format.
  137.  
  138. The GAME.CFG file
  139. ~~~~~~~~~~~~~~~~~
  140. The Sports Line Pool Door   <-- Line 1  (See below)
  141. c:\sf\door.sys              <-- Line 2    "     "
  142. The Gamekeeper's Lair       <-- Line 3    "     "
  143. Steve Sharpe                <-- Line 4    "     "
  144. 000000000000                <-- Line 5    "     "
  145. 1                           <-- Line 6    "     "
  146.  
  147. Line 1 - This line reflects the name of the door.  The registration algorithm
  148. is based on some of this data.  DO NOT CHANGE LINE 1!
  149.  
  150. Line 2 - Enter the full path and filename for the BBS DOOR.SYS file.
  151.  
  152. Line 3 - Enter the name of your BBS.
  153.  
  154. Line 4 - Enter the SysOp's name.
  155.  
  156. Line 5 - Enter 12 zeros if the door is not registered.  Registered users enter
  157. the registration number provided by the author.  Other numbers will prevent
  158. the door from running.
  159.  
  160. Line 6 - Enter 1 if your BBS DOOR.SYS drop file is the original GAP standard
  161. 31 line version.  Enter 2 if your BBS DOOR.SYS drop file is the newer (longer)
  162. version (presently 52 lines).
  163.  
  164. The POOL.CFG file
  165. ~~~~~~~~~~~~~~~~~
  166. U      <-- Line 1 (See below)
  167. 1      <-- Line 2   "     "
  168. Sysop  <-- Line 3   "     "
  169. F      <-- Line 4   "     "
  170.  
  171. Line 1 - This line reflects the current pool status and must be set to U to
  172. unlock the pool for use.  If the SysOp desires to manually lock the pool, set
  173. line 1 to L.  The door will automatically change the pool status to W
  174. (waiting for update) when FREEZE.EXE is run (normally as an event).  After the
  175. update, the door will automatically unlock the pool for use again.  When the
  176. last period has been reached, the door will set line 1 to C to indicate the
  177. season is complete.
  178.  
  179. Line 2 - This line reflects the current period.  Always start a new pool with
  180. 1.  The door will automatically advance this number after each update.
  181.  
  182. Line 3 - Enter the name of the user (exactly as the BBS user record reflects)
  183. who will be responsible for updating the pool.  All other users will be locked
  184. out while the pool status is W (waiting for update) until this person logs on
  185. and provides the door with win/loss/tie results for the period.
  186.  
  187. Line 4 - This line controls the title graphics and internal game headings.
  188. Enter F for Football Pool, B for Baseball Pool, H for Basketball Pool, or any
  189. other single character for the Generic Pool.
  190.  
  191. TEAM DATA FILES
  192. ~~~~~~~~~~~~~~~
  193. The team data files are ASCII text files that must follow a simple but strict
  194. format.  The first line always contains the date the games will be played.
  195. This is the period date.  The lines that follow are the teams themselves.  The
  196. away team is identified first, followed by the home team.  The teams are
  197. separated by a comma.  For example, the first 3 lines of a football pool data
  198. file should look like:
  199.  
  200. SEPTEMBER 15, 1992
  201. San Diego Chargers,Miami Dolphins
  202. Chicago Bears,Minnesota Vikings
  203.  
  204. The resulting screen display from inside the door would read:
  205.  
  206. San Diego Chargers    at    Miami Dolphins
  207. Chicago Bears         at    Minnesota Vikings
  208.  
  209. The file would be saved as 1.DAT (for period 1), etc.  Refer to the 3 sample
  210. .DAT files provided.  THE FOLLOWING LIMITATIONS APPLY:  Each team name cannot
  211. exceed 21 characters in length and there cannot be more than 15 teams in any
  212. one period file (16 lines including the date).  DAT files must always start
  213. with 1 and additional DAT files must be in numeric sequence (if a number is
  214. skipped, the pool will indicate the season is over!).
  215.  
  216. SEASON'S OVER/RESET
  217. ~~~~~~~~~~~~~~~~~~~
  218. At the end of the season, the door can be left in C status indefinitely so
  219. that users can use the Review and Top Pick options within the door.  To reset
  220. the door for a new season or a different pool, follow these steps:
  221.  
  222. 1.  Delete all .FIL, .DAT, and .USR files.
  223.  
  224. 2.  Create new team data (.DAT) files.
  225.  
  226. 3.  Edit the POOL.CFG file, as described previously, to begin the new pool
  227. with period 1.
  228.  
  229. SYSOP KEYS
  230. ~~~~~~~~~~
  231. The following keys assist the SysOp in the management of the door:
  232.  
  233.          F5 - Shell to DOS
  234.          F8 - Return user to system
  235.          F9 - Toggle display on/off
  236.         F10 - Chat mode (ESC to exit)
  237.       ALT H - Toggle between status lines
  238.  
  239. REGISTRATION
  240. ~~~~~~~~~~~~
  241. The registration fee for The Sports Line Pool Door is $5.  The unregistered
  242. door displays "EVALUATION COPY" upon entry and exit.  Please register or
  243. remove the door within 90 days of first use.  As a BBS SysOp, I understand how
  244. costly it can be to register BBS software.  I have purposely kept the cost of
  245. registering The Sports Line Pool Door to a minimum with that thought in mind.
  246. I believe the fee is quite reasonable, based on the many long hours of
  247. programming required.  Upon receipt of the registration fee, you will be
  248. provided with a unique registration number.  Once you insert the registration
  249. number into the GAME.CFG file, the opening and closing "EVALUATION COPY"
  250. messages will be replaced with the following messages:
  251.  
  252. [OPENING MESSAGE]
  253.  
  254.                                 Your BBS name
  255.  
  256.                                   presents
  257.  
  258. [CLOSING MESSAGE]
  259.  
  260.                              Thanks for playing
  261.  
  262.                           The Sports Line Pool Door
  263.  
  264.                                      on
  265.  
  266.                                Your BBS name
  267.  
  268. COMMENTS/BUG REPORTS
  269. ~~~~~~~~~~~~~~~~~~~~
  270. I'm interested in all user comments and bug reports.  Please send your comments
  271. to:
  272.  
  273. Steve Sharpe                              Call The Gamekeeper's Lair BBS
  274. 1835 Stonetree Dr.              or        (208) 587-1105
  275. Mountain Home, ID 83647                   and leave a message
  276.  
  277.                                  Warranty
  278.                                ------------
  279.        This program has been thoroughly tested on a Spitfire 3.2 BBS,
  280.        however, it should perform equally well on any BBS that can
  281.        produce a BBS drop file listed in this documentation.
  282.  
  283.        I make no warranty of any kind, express or implied, including
  284.        without limitation, any warranties of merchantability and/or
  285.        fitness for a particular purpose.  I shall not be held liable for
  286.        any  damages, whether direct, indirect, special or consequential
  287.        arising from a failure  of this program to operate in the manner
  288.        desired by the user.  I shall not be held liable for any damage to
  289.        data or property which may be caused directly or indirectly by the
  290.        use of this program.
  291.  
  292.        In no event will I be held liable for any damages, including (but
  293.        not limited to) any lost profits, lost savings or other incidental
  294.        or consequential damages arising out of the use or inability to
  295.        use this program, or for any claim by any other party.
  296.  
  297.        This warranty is governed by the laws of the State of Idaho.
  298.                               REGISTRATION FORM
  299.                               -----------------
  300.  
  301.   The Sports Line Pool Door        Return to:  Steve Sharpe
  302.   Version 1.6                                  Attn: Door Registration
  303.   Registration Cost: $5                        1835 Stonetree Dr.
  304.                                                Mountain Home, ID 83647
  305.  
  306.   Name ______________________________________________________________
  307.  
  308.   Address ___________________________________________________________
  309.  
  310.           ___________________________________________________________
  311.  
  312.   Voice Phone _____________________ Data Phone ______________________
  313.  
  314.   Enter GAME.CFG file information below:
  315.  
  316.   BBS Name______________________________________________
  317.  
  318.   SysOp Name____________________________________________
  319.  
  320.   CHOOSE ONE OPTION BELOW:
  321.  
  322.   ____  I wish to download my registration number from The Gamekeeper's Lair
  323.         BBS at (208) 587-1105.  Enter the password you will use to log on to
  324.         The Gamekeeper's Lair BBS: _________________________________________
  325.         Enter your birthdate for pre-verification: _________________________
  326.         Please allow enough time for your registration fee to reach the author
  327.         before calling for your registration number.
  328.  
  329.   ____  I wish to have my registration number mailed to the address listed
  330.         above.
  331.  
  332.   Orders outside the USA add $2.00 . . . . . . . . . . . . _________
  333.  
  334.       Please find enclosed a check or money order for USA $_________
  335.   payable to Steve Sharpe.  This shows my support of Shareware products
  336.   and the Shareware concept.  It also shows my encouragement to help further
  337.   the development of BBS doors.
  338.  
  339.       I understand that The Sports Line Pool Door is provided as-is and no
  340.   warranties of any kind, expressed or otherwise, are included and that I am
  341.   using it at my own risk.
  342.  
  343.   Signed: _________________________________________  Date: _________
  344.